Skip to main content
Feedback

Usage

  1. The following pre-input configuration states the name of header to fetch from incoming request which holds region code meta data.

    regioncodeheader:<HTTP header name that holds the API request region code>

    For example, regioncodeheader:HTTP-REQUEST-REGION-KEY

  2. The following pre-input configuration holds the details of region code and hostname association. Region code will be matched with the header value of the header specified for 'regioncodeheader' pre input.

    regioncodevalue:{<Code1>:<URI1>, <Code2>:<URI2> ......}

    For example, regioncodevalue:{"SG": "https://api-sg.acme.com/api/v1","CN": "https://api-sg.acme.com/api/v1", "NL": "https://api-emea.acme.com/api/v1"

    If the incoming header in the request 'HTTP-REQUEST-REGION-KEY' has the value 'SG', the configuration will be routed to 'SG', the configured host 'api-sg.gta.com/api/v1'.

  3. The following pre-input configuration holds the default target URI which is used for target routing in case when regioncodeheader is not present in the request or coming with an empty value.

    targetdefaulturi:<Contains the default target URI>

    For example, targetdefaulturi: https://uki.acme-travel.com/api/v1

Sample Example

  • https://api.acme.com/aladdapi

  • API Inbound Region Code Header: HTTP-REQUEST-REGION-KEY : CN

  • Data to make available for pre-processing (Normal flow):

    • regioncodeheader:HTTP-REQUEST-REGION-KEY

    • regioncodevalue:{"SG": "https://api-sg.acme.com/api/v1","CN": "https://api-sg.acme.com/api/v1", "NL": "https://api-emea.acme.com/api/v1"}

    • targetdefaulturi:https://uki.acme-travel.com/api/v1

    • Sample curl call without region code header:

      curl -i -v -H 'Host:localapi.localproxy.mashery.com' 'http://localhost:8080/aladdapi?api_key=key'

      In this case API request is sent to the URI "https://uki.acme-travel.com/api/v1".

    • Sample curl call with region code header:

      curl -i -v -H 'Host:localapi.localproxy.mashery.com' 'http://localhost:8080/aladdapi?api_key=key' -H 'HTTP-REQUEST-REGION-KEY:CN'

      In this case API request is sent to the URI "https://api-sg.acme.com/api/v1".

FAQs

Does this Policy support conditional routing?

Yes, The Policy supports conditional routing of the API request based on meta data provided in the HTTP header.

Does this Policy support conditional routing only for geo routing?

No, The Policy supports conditional routing of the API request based on any meta data provided in the HTTP header. It is powerful feature agnostic to type of meta data.

Does this Policy support header enrichment based on API Management model's attribute?

Yes, The Policy supports header enrichment with value from API Management supported model's attributes. Currently it supports package_keys, packages, keys and plans model attributes.

Does this Policy support header enrichment with static value as well?

Yes, The Policy supports header enrichment with a static value which can be configured.

On this Page